Iniciar um pagamento

POSTBase URL

/:companyId/banking/primitives/payments

Cria uma ordem de débito na conta da empresa por um único meio de pagamento (rail): Pix, TED, boleto, DARF, entre outros.

O status começa em initiated e avança conforme o meio de pagamento processa a ordem. Se o pagamento exigir aprovação, fica em pending_approval até que ela ocorra. Para incluir o pagamento em um lote, informe batchRef.

Envie X-Idempotency-Key: repetir a chamada com a mesma chave devolve o mesmo pagamento, sem debitar duas vezes.

Request Specifications

Request

Responses

201

Pagamento iniciado (pode aguardar aprovação)

400

400 — a requisição não pôde ser interpretada. Duas causas: missing-idempotency-key, quando um POST ou PATCH não traz X-Idempotency-Key; e invalid-body, quando o corpo não segue o schema da operação (campo obrigatório ausente ou tipo errado). O campo invalidParams indica o que corrigir.

422

Combinação de campos inválida. invalidParams indica o que corrigir.